Generate unified Python/C++ docs #13846
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vyasr
added
feature request
github-actions
bot
added
libcudf
github-actions
bot
added
CMake
vyasr
force-pushed
the
feat/unify_docs
branch
from
42f2fe0
to
582b455
Compare
vyasr
force-pushed
the
feat/unify_docs
branch
from
582b455
to
18d7dc2
Compare
3 tasks
vyasr
force-pushed
the
feat/unify_docs
branch
from
18d7dc2
to
84d9a11
Compare
|
/ok to test |
rapids-bot bot
pushed a commit
that referenced
this pull request
Dec 5, 2023
Doxygen-generated XML is parsed by Breathe, so this is a prerequisite for #13846. Authors: - Vyas Ramasubramani (https://github.com/vyasr) Approvers: - Karthikeyan (https://github.com/karthikeyann) URL: #14477
vyasr
force-pushed
the
feat/unify_docs
branch
from
07c89c4
to
b342de8
Compare
vyasr
force-pushed
the
feat/unify_docs
branch
2 times, most recently
from
5022e4e
to
b4e2516
Compare
vyasr
force-pushed
the
feat/unify_docs
branch
from
80c40ed
to
dc5191d
Compare
shwina
approved these changes
Jan 10, 2024
|
In the interest of moving forward in more incremental steps, I've put back doxygen HTML generation, so this PR won't disable those docs yet. We can do that at a later date when we're happier with the output of the Sphinx C++ documentation. Merging this PR in closer to its current state will allow us to iterate and improve more easily than having to perfect the appearance in this PR before removing the doxygen HTML. |
4 tasks
karthikeyann
approved these changes
Jan 12, 2024
davidwendt
approved these changes
Jan 17, 2024
|
/merge |
This was referenced Jan 18, 2024
rapids-bot bot
pushed a commit
that referenced
this pull request
Jan 18, 2024
In my initial pass through enabling Breathe I tried to leave a minimal footprint of external modification to the generated files. In this particular case it looks like the problematic attributes can appear in more places than I originally observed. I never observed this behavior in that PR, but I don't know if these now appear due to something that merged after #13846 or something else changing in the environment (e.g. a Sphinx or doxygen behavior etc). Nonetheless, blanket wiping these is the simpler and safer option. The docs build successfully locally with this change. Authors: - Vyas Ramasubramani (https://github.com/vyasr) Approvers: - Bradley Dice (https://github.com/bdice) URL: #14780
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR leverages Breathe to pull the cudf C++ API documentation into the python Sphinx docs build, generating a single unified build of the documentation that supports cross-linking between language libraries and also simplifies cross-linking from other libraries that wish to link here.
This PR also revealed numerous other issues with our doxygen docs. I've submitted those as separate patches to control the diff here, but it's worth noting that Sphinx is much louder with warnings than doxygen and will help us avoid many more issues with broken documentation than doxygen alone could.
Resolves #11481
Checklist